home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / wordproc / wf_v31c.arj / DOCS / WF.015 < prev    next >
Text File  |  1992-01-31  |  12KB  |  342 lines
  1. .f3                              - # -              Chapter 15 - Indexing
  2. .rm70
  3. .tc
  4. .tc 15. INDEXING ..........................................#
  5. CHAPTER 15   INDEXING
  6.  
  7. .IMIndexing
  8. An index is an alphabetic listing of topics in the text, each with a
  9. list of page numbers where the phrase can be found. Word Fugue can
  10. create document indexes.
  11.  
  12. .tc    Specifying Index Entries ...........................#
  13. Specifying Index Entries
  14.  
  15. .ix   Marking with .IX command
  16. .ix   Marking with ^K command
  17. .ix   Specifying index entries
  18. .ixDot Commands;  .IX - Index Entry
  19. Individual words and phrases can be marked in the text by pressing
  20. Ctrl P K before and after the phrase you want to include in the index.
  21. For example:
  22.  
  23.       This paragraph explains about ^K indexing documents^K
  24.  
  25. The bracketing ^Ks do not print, they are only there to mark an index
  26. entry. Any characters between the two markers will be included in the
  27. index when it is generated.
  28.  
  29. You can also enter a word or phrase by using the .IX dot command. The
  30. dot must appear in the first column. For example:
  31.  
  32.         .IX indexing documents
  33.  
  34. In either case, the maximum length of an index phrase is 50
  35. characters, and is counted from the first character following the .ix
  36. or the ^K. Extra characters are ignored. In each case, the same phrase
  37. indexing documents will be included in the index, with a leading
  38. space.
  39.  
  40. You will be prompted for the name of the file to generate the index
  41. for. If you elect to use the same name as the file you are editing,
  42. Word Fugue will use the disk version of the file.
  43.  
  44. .ix   File name used
  45. The output file name will be that of the input file name, with the
  46. extension set to .IDX
  47.  
  48. .ix   Major heading prefix
  49. To assist sorting of index entries, you can create major headings by
  50. prefixing the index entry by the major heading, followed by a
  51. semicolon ';'. These major sort keys are limited to 14 characters.
  52. When you use major heading, you can still have 50 characters for the
  53. index entry (counted from the first character after the semicolon).
  54.  
  55. .tc    Generating an Index ................................#
  56. Generating an Index
  57.  
  58. .ix   Generation of
  59. Press Ctrl F6 to commence the operation. Word Fugue will prompt you with
  60.  
  61.       Enter file name to index
  62.  
  63. The file name will default to the last entry for editing, and may
  64. contain wild cards if that was how you selected your last file for
  65. editing. When you enter a file name, Word Fugue will generate an index.
  66. If you press enter with wild cards showing ('*' or '?'), you will see
  67. a picklist from which to select your file. You can cancel the
  68. operation by pressing ESC at the prompt. In addition, you can abort
  69. the index operation part way through by pressing the abort command ^U.
  70.  
  71. .CP15
  72. It typically takes about 1 second per page on a slow 4.7Mhz IBM or
  73. clone, and the message Working is displayed on the top line. The
  74. generation will use the file(s) on disk, so be sure to save the file
  75. you are editing so that the latest changes will be included in your
  76. index. During generation, each index entry occupies about 80
  77. characters of memory,Thus, if you are editing a large document, you
  78. may run out of memory. In this case, close all files to free up
  79. memory, and do the index operation when you are editing a blank file,
  80. or exit re-enter with an empty file.
  81.  
  82. .ix   Memory usage
  83. .ix   Working with large documents
  84. .ixTIPS;   Indexing the chapters of a book
  85. .ixTIPS;   Break Large documents into chapters
  86. TIP - if you are writing a book or similar, with several chapters, set
  87.       each chapter up as a separate file, and create a master file
  88.       that includes each chapter, table of contents & index file by
  89.       use of .FI commands. Generate the index for the top level file,
  90.       and all lower level files will be included.
  91.  
  92. .tc    Sample Input and Output ............................#
  93. Sample Input and Output
  94.  
  95. .IMIndexing
  96. .ix   Specifying index entries
  97. Given this simple input:
  98.  
  99.                     .ix Indexing;  Generation
  100.                     .ix Indexing;  Specifying Entries
  101.                     .ix Indexing;Indexing
  102.  
  103. appearing on several pages of the document, the indexing operation
  104. will produce the following output:
  105.  
  106.                        Indexing, 2-4,6
  107.                          Generation, 2-4,6
  108.                          Specifying Entries, 2-4,6
  109.  
  110. where the figures appearing after the index text are the page
  111. references. Each entry is sorted alphabetically, but upper and lower
  112. case are ignored. To sort various entries together, you should
  113. prefix them all with the same major heading, as shown above.
  114.  
  115. Please note that spaces following after the .IX command are
  116. significant, and will be used as part of the sort key.
  117.  
  118. This process can be made more easy by use of Index Major entries.
  119.  
  120. .tc    Index Major Entries ................................#
  121. Index Major Entries
  122.  
  123. .ix   Marking with .IM command
  124. .ixDot Commands;  .IM - Index Major heading
  125. If you prefer a more tarted up output produced automatically, you can
  126. specify the sort prefix for index entries by use of the .IM command to
  127. set a major heading for index entries. The text following the .IM
  128. command will appear in the index, and will also be used as a sort
  129. prefix for subsequent .IX commands and text between ^K markers. The
  130. same prefix will be used for all index entries until the appearance of
  131. another .IM command.
  132.  
  133. .CP6
  134. The example above could be re-written as:
  135.  
  136.                     .im INDEXING
  137.                     .ix   Specifying Entries
  138.                     .ix   Generation
  139.  
  140. .CP5
  141. and would produce:
  142.  
  143.                      INDEXING
  144.                        Generation, 2-4,6
  145.                        Specifying Entries, 2-4,6
  146.  
  147. The difference between this and the previous example using prefixes is
  148. that .IM entries are index entries in their own right, while the major
  149. heading prefixes in .IX and ^K entries do not appear in the index, but
  150. are used merely for sequencing or sorting of the index entries. In
  151. addition, Index Major entries do not have page references generated
  152. for them.
  153.  
  154. When using .IM entries, the text is restricted to 50 characters
  155. following the .IM, as for .IX entries. The first 14 characters of the
  156. .IM entry is used for sequencing or sorting, as with the prefix
  157. method.
  158.  
  159. Please note that spaces following the .IM command are significant, and
  160. will be used as part of the sort key.
  161.  
  162. .IMIndexing
  163. .ix   Specifying index entries
  164. You can also include font commands to make the entries bold, italic,
  165. double height or width etc.
  166.  
  167. The format of the output is as shown above - each entry occupies 2
  168. lines, the first for the entry, the second for the page number
  169. references separated by commas. Note that if 3 or more consecutive
  170. page numbers are found, they are abbreviated to the first and last
  171. number, separated by a hyphen.
  172.  
  173. Thus pages 2, 3, 6 and 7 would appear
  174.  
  175.         2,3,6,7
  176.  
  177. while pages 2, 3, 4, 5, 9, 10, 11 and 15 would appear as
  178.  
  179.         2-5,9-11,15
  180.  
  181. .tc    Index Refer to Entries .............................#
  182. Index Refer To Entries
  183.  
  184. .ix   Marking with .IR command
  185. .ixDot Commands;  .IR - Index Refer to
  186. Sometimes you need to insert index entries under a topic heading with
  187. only a "Refer to ..." entry. In this case you do not want that line
  188. having a page reference. For this you can use the .IR command, which
  189. is otherwise identical to the .IX command.
  190.  
  191. For example:
  192.                     .im INDEXING
  193.                     .ix   Specifying Entries
  194.                     .ix   Generation
  195.                     .ir   See also Table of Contents
  196.  
  197. and would produce:
  198.  
  199.                      INDEXING
  200.                        Generation, 2-4,6
  201.                        See also Table of Contents
  202.                        Specifying Entries, 2-4,6
  203.  
  204. .CP10
  205. .tc    Width of the Index Line ............................#
  206. Width of the Index Line
  207. .ix   Width of Index Line (.IW)
  208. .ixDot Commands;  .IW - Index Width
  209.  
  210. Defaults
  211.  
  212. The default width of the index line is 65 characters. If the text or
  213. list of page references extends beyond the width of the line, it will
  214. continue on the next line, indented by 4 characters.
  215.  
  216. Setting Different Values
  217.  
  218. The .IW (Index Width) dot command can be used to change the width of
  219. the line or the indentation of continuation lines. The format is
  220.  
  221.     .IW  w,i
  222.  
  223.   where w is the maximum width
  224.         i is the indentation to use on continuation lines.
  225.  
  226. This is useful if the index is to appear in 2 or 3 columns. You set
  227. the appropriate width and you can be sure that none of the lines will
  228. extend beyond that width.
  229.  
  230. For example:
  231.                     .iw 25,5
  232.                     .im INDEXING
  233.                     .ix   Specifying Entries
  234.                     .ix   Generation
  235.                     .ir   See also Table of Contents
  236.  
  237. and would produce:
  238.  
  239.                      INDEXING
  240.                        Generation, 2-4,6
  241.                        See also Table of
  242.                          Contents
  243.                        Specifying Entries,
  244.                          2-4,6
  245.  
  246. The 25th character position appears in the middle of the word
  247. "Contents", so this word is wrapped onto a continuation line. In
  248. addition, there is not enough room to fit "2-4" on the line
  249. "Specifying Entries", so it appears on the next line. In both cases
  250. the continuation line is indented by 5 characters. (Remember that the
  251. text starts with a blank character in the example, so there is a
  252. leading space before each line which must be counted.
  253.  
  254. The command can appear anywhere within the document, since generation
  255. of index entries does not take place until the entire document has
  256. been scanned. If several commands appear, only the last one will be
  257. effective.
  258.  
  259. .CP10
  260. .tc    Tips with Indexes ..................................#
  261. Tips with Indexes
  262.  
  263. .ix   Tips with
  264. .tc       Blank Line Before Entry .........................#
  265. Blank Line Before Entry
  266.  
  267. To produce a blank line before the major index heading, use an .IR
  268. line with only the major heading filled in, and set so that it will
  269. sort immediately before the major heading
  270.  
  271.      for example:
  272.               .IMWindows
  273.               .IRWindowa;
  274.  
  275. will produce a blank line before the Windows heading. "Windowa" will
  276. sort before "Windows", and the semi colon defines that the .IR line
  277. only has a major heading (which does not print).
  278.  
  279. .tc       Inserting Dot Commands ..........................#
  280. Inserting Dot Commands
  281.  
  282. .ix   2 Columns
  283. If you want to have dot commands automatically included in the index
  284. file, you can put them on a .IR line with a major sort key that
  285. ensures that they appear in the appropriate place. Please note that
  286. the commands will be sorted, so you must take care about the sort key
  287. to ensure that they appear in the right place. The best method is to
  288. go over the index manually to include the formatting you want.
  289.  
  290.     For example:
  291.  
  292.         .IR ;.co 2,5
  293.  
  294. will put the dot command
  295.  
  296.         .CO 2,5
  297.  
  298. into the index, meaning that it will print in 2 snaking columns. The
  299. ";" specifies that the major sort key is spaces, and will ensure
  300. that this dot command will sort before any other index command.
  301.  
  302. .CP7
  303.     For example:
  304.  
  305.         .IR ;.co 2,5
  306.         .IR ;.aa nnn
  307.  
  308. will put the dot commands
  309.  
  310.         .aa nnn
  311.         .co 2,5
  312.  
  313. into the text, since .AA will sort before .CO. You can change this by
  314. changing the above to:
  315.  
  316.         .IR a;.co 2,5
  317.         .IR b;.aa nnn
  318.  
  319. will put the dot commands
  320.  
  321.         .co 2,5
  322.         .aa nnn
  323.  
  324. .CP5
  325. since "a" will sort before "b". Note that there is still a leading
  326. space to ensure that these entires sort to the head of the index.
  327.  
  328. .ixTIPS;   Indexing Dot Commands
  329. TIP - If you are preparing a manual such as this, and you want dot
  330.       commands to appear in the printed text of the index, prefix the
  331.       dot command with ^K to prevent Word Fugue from treating it as an
  332.       actual dot command :-
  333.  
  334.         .ixFM;^K.FM - Footer Margin
  335.  
  336.       will place the text ^K.FM - Footer Margin into the index file.
  337.       At print time, the ^K will be deleted.
  338.  
  339.       If you do not do this, the command will in column one, and Word
  340.       Fugue will treat it as an actual dot command, and not print it.
  341.  
  342.